Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor Fix: links in P4Smith page #4828

Merged
merged 2 commits into from
Jul 23, 2024
Merged

Conversation

AdarshRawat1
Copy link
Member

@AdarshRawat1 AdarshRawat1 commented Jul 22, 2024

Fixes

Other Change

Refactored Absolute links in contribution guidelines to relative links.

This change ensures that the generated documents refer to the correct sections within the Generated docs themselves, instead of redirecting users to GitHub.
Note: The Changes are compatible in GitHub-flavor Markdown as well.

@jafingerhut
Copy link
Contributor

I guess doxygen doesn't have anything built into its functionality to recognize that Github-flavored Markdown files can have relative links?

@AdarshRawat1
Copy link
Member Author

AdarshRawat1 commented Jul 22, 2024

I guess doxygen doesn't have anything built into its functionality to recognize that Github-flavored Markdown files can have relative links?

Doxygen can't render directories!! It is not possible to show directory content in generated docs (Applies to almost all the documentation tools).
Relative links work in Doxygen, but that applies only to README files and their section.

This change ensures that the generated documents refer to the correct sections within the documents themselves, instead of redirecting users to GitHub.

Signed-off-by: Adarsh <[email protected]>
@fruffy fruffy added the documentation Topics related to compiler documentation. label Jul 22, 2024
@fruffy fruffy added this pull request to the merge queue Jul 23, 2024
Merged via the queue into p4lang:main with commit 132122d Jul 23, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Topics related to compiler documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants